home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / gui / gadtoolsbox20c.lha / GadToolsBox / GTXLib / Docs / gtx.doc < prev    next >
Encoding:
Text File  |  1993-04-01  |  28.1 KB  |  847 lines
  1.  
  2. gtx.doc - (C) Copyright 1992,1993 Jaba Development
  3.  
  4. TABLE OF CONTENTS
  5.  
  6. gadtoolsbox.library/GTX_TagInArray
  7. gadtoolsbox.library/GTX_SetTagData
  8. gadtoolsbox.library/GTX_GetNode
  9. gadtoolsbox.library/GTX_GetNodeNumber
  10. gadtoolsbox.library/GTX_CountNodes
  11. gadtoolsbox.library/GTX_MoveNode
  12. gadtoolsbox.library/GTX_IFFErrToStr
  13. gadtoolsbox.library/GTX_GetHandleA
  14. gadtoolsbox.library/GTX_FreeHandle
  15. gadtoolsbox.library/GTX_RefreshWindow
  16. gadtoolsbox.library/GTX_CreateGadgetA
  17. gadtoolsbox.library/GTX_RawToVanilla
  18. gadtoolsbox.library/GTX_GetIMsg
  19. gadtoolsbox.library/GTX_ReplyIMsg
  20. gadtoolsbox.library/GTX_SetGadgetAttrsA
  21. gadtoolsbox.library/GTX_DetachLabels
  22. gadtoolsbox.library/GTX_DrawBox
  23. gadtoolsbox.library/GTX_InitTextClass
  24. gadtoolsbox.library/GTX_InitGetFileClass
  25. gadtoolsbox.library/GTX_SetHandleAttrsA
  26. gadtoolsbox.library/GTX_BeginRefresh
  27. gadtoolsbox.library/GTX_EndRefresh
  28. gadtoolsbox.library/GTX_FreeWindows
  29. gadtoolsbox.library/GTX_LoadGUIA
  30.  
  31. gadtoolsbox.library/GTX_TagInArray         gadtoolsbox.library/GTX_TagInArray
  32.  
  33.   NAME  GTX_TagInArray()
  34.  
  35.     inarray = GTX_TagInArray( tag, taglist );
  36.  
  37.     BOOL GTX_TagInArray( Tag, struct TagItem * );
  38.     D0                   D0   A0
  39.  
  40.   FUNCTION
  41.     To  do  about  the same  as  utility.library  it's  TagInArray()  with the
  42.     exception that  this  routine  will look  through  a TagItem array to find
  43.     a matching Tag.  Tags  like  TAG_MORE  or TAG_IGNORE  are ofcourse handled
  44.     correctly.
  45.  
  46.   INPUTS
  47.     tag         - Tag value to search the TagItem array for.
  48.     taglist     - A pointer to a TAG_END terminated TagItem array.
  49.  
  50.   RESULT
  51.     inarray     - This is a boolean which will be TRUE if the Tag is  found in
  52.                   the array and FALSE if the Tag wasn't found.
  53.  
  54.   BUGS
  55.     None known.
  56.  
  57.   SEE ALSO
  58.     utility.library/TagInArray()
  59.  
  60. gadtoolsbox.library/GTX_SetTagData              gadtoolsbox.library/SetTagData
  61.  
  62.   NAME  GTX_SetTagData()
  63.  
  64.     success = GTX_SetTagData( tag, data, taglist );
  65.  
  66.     BOOL GTX_SetTagData( Tag, ULONG, struct TagItem * );
  67.     D0                   D0   D1     A0
  68.  
  69.   FUNCTION
  70.     This does the opposite as utility.library it's  GetTagData().   It searches
  71.     through  the  TagItem  array to  find the specified Tag and  then sets it's
  72.     data field to the supplied value.
  73.  
  74.   INPUTS
  75.     tag         - The Tag from which to set it's data field.
  76.     data        - The data value to set in the TagItem.
  77.     taglist     - A pointer to a TAG_END terminated TagItem array.
  78.  
  79.   RESULT
  80.     success     - This is a boolean which will be TRUE when the  Tag was  found
  81.                   in the array and it's data field  was set or  FALSE when  the
  82.                   Tag was not found in the array.
  83.  
  84.   BUGS
  85.     None known.
  86.  
  87.   SEE ALSO
  88.     utility.library/GetTagData()
  89.  
  90. gadtoolsbox.library/GTX_GetNode                gadtoolsbox.library/GTX_GetNode
  91.  
  92.   NAME  GTX_GetNode()
  93.  
  94.     node = GTX_GetNode(  list, nodenum );
  95.  
  96.     struct Node *GTX_GetNode( struct List *, ULONG );
  97.     D0                        A0             D0
  98.  
  99.   FUNCTION
  100.     To get a pointer to a Node from a list.  Typically this routine is used for
  101.     getting a pointer to the selected Node of a ListView gadget.
  102.  
  103.   INPUTS
  104.     list        - A pointer to a List structure.
  105.     nodenum     - The ordinal number of the Node (starting from 0 for the first
  106.                   node).
  107.  
  108.   RESULT
  109.     node        - A pointer to the  requested  Node  or NULL  if you  passed  a
  110.                   wierd Node number ( Node number 11 in a list with 5 nodes..).
  111.  
  112.   BUGS
  113.     None known.
  114.  
  115.   SEE ALSO
  116.     exec/nodes.h, exec/lists.h
  117.  
  118. gadtoolsbox.library/GTX_GetNodeNumber    gadtoolsbox.library/GTX_GetNodeNumber
  119.  
  120.   NAME  GTX_GetNodeNumber()
  121.  
  122.     nodenum = GTX_GetNodeNumber( list, node );
  123.  
  124.     LONG GTX_GetNodeNumber( struct List *, struct Node * );
  125.     D0                      A0             A1
  126.  
  127.   FUNCTION
  128.     To do the opposite of GTX_GetNode().  This will return  the node  number of
  129.     the Node.
  130.  
  131.   INPUTS
  132.     list        - A pointer to a List structure.
  133.     node        - A pointer to the Node from which you want to know it's number
  134.  
  135.   RESULT
  136.     nodenum     - This will be the number of the Node in the  list or -1 if you
  137.                   passed a Node which is not located in the passed list.
  138.  
  139.   BUGS
  140.     None know.
  141.  
  142.   SEE ALSO
  143.     GTX_GetNode()
  144.  
  145. gadtoolsbox.library/GTX_CountNodes          gadtoolsbox.library/GTX_CountNodes
  146.  
  147.   NAME  GTX_CountNodes()
  148.  
  149.     num = GTX_CountNodes( list );
  150.  
  151.     ULONG GTX_CountNodes( struct List * )
  152.     D0                    A0
  153.  
  154.   FUNCTION
  155.     To find out how many Nodes are attached to a List.
  156.  
  157.   INPUTS
  158.     list        - A pointer to a List structure.
  159.  
  160.   RESULT
  161.     num         - The number of Nodes attached to the List.
  162.  
  163.   BUGS
  164.     None known.
  165.  
  166.   SEE ALSO
  167.     exec/lists.h, exec/nodes.h
  168.  
  169. gadtoolsbox.library/GTX_MoveNode              gadtoolsbox.library/GTX_MoveNode
  170.  
  171.   NAME  GTX_MoveNode()
  172.  
  173.     success = GTX_MoveNode( list, node, direction );
  174.  
  175.     BOOL GTX_MoveNode( struct List *, struct Node *, WORD );
  176.     D0                 A0             A1             D0
  177.  
  178.   FUNCTION
  179.     To move a Node one place up or down in a list.
  180.  
  181.   INPUTS
  182.     list        - A pointer to a List structure.
  183.     node        - A pointer to the node which must be moved.
  184.     direction   - The direction in which the node will be moved.   When this is
  185.                   is negative the Node will be moved up (towards the List head)
  186.                   in the list. When this  is  positive the Node  will be  moved
  187.                   down (towards the List tail) in the list. When this is  0 the
  188.                   Node will not be moved and success is returned.
  189.  
  190.   RESULT
  191.     success     - This will be TRUE when the node was  actually  moved. When it
  192.                   is not moved, for example when you try to move it  up  whilst
  193.                   it is alread at the top of the List, this will be FALSE.
  194.  
  195.   BUGS
  196.     None known.
  197.  
  198.   SEE ALSO
  199.     exec/lists.h, exec/nodes.h
  200.  
  201. gadtoolsbox.library/GTX_IFFErrToStr        gadtoolsbox.library/GTX_IFFErrToStr
  202.  
  203.   NAME  GTX_IFFErrToStr()
  204.  
  205.     string = GTX_IFFErrToStr( error, skipeof );
  206.  
  207.     UBYTE *GTX_IFFErrToStr( LONG, BOOL );
  208.     D0                      D0    D1
  209.  
  210.   FUNCTION
  211.     To  return  you  a  pointer  to  a  human-readable  string  concerning  the
  212.     iffparse.library error codes.
  213.  
  214.   INPUTS
  215.     error       - A signed integer containing the iffparse.library error  code.
  216.     skipeof     - A boolean which must be  set to  TRUE if you  do  not   wan't
  217.                   this routine to respond to IFFERR_EOF and IFFERR_EOC  errors.
  218.  
  219.   RESULT
  220.     string      - A pointer to the error string or NULL  when  the  error  code
  221.                   did not contain a known iffparse error.
  222.  
  223.   BUGS
  224.     None known.
  225.  
  226.   SEE ALSO
  227.     libraries/iffparse.h
  228.  
  229. gadtoolsbox.library/GTX_GetHandleA          gadtoolsbox.library/GTX_GetHandleA
  230.  
  231.   NAME  GTX_GetHandleA()
  232.  
  233.     handle = GTX_GetHandleA( tags )
  234.  
  235.     HOTKEYHANDLE GTX_GetHandleA( struct TagItem * );
  236.     D0                           A0
  237.  
  238.     HOTKEYHANDLE GTX_GetHandle( Tag, ... );
  239.  
  240.   FUNCTION
  241.     To setup a handle for automatic gadget hotkey handling.   This  will return
  242.     a  HOTKEYHANDLE  uppon  success.   This  is  a pointer  to  a  private data
  243.     structure typedef'ed to HOTKEYHANDLE in gadtoolsbox/hotkey.h.   This handle
  244.     is *extremely* important for the automatic hotkey system.
  245.  
  246.   INPUTS
  247.     tags        - A pointer to a TagItem chain.
  248.  
  249.   TAGS
  250.     HKH_KeyMap          - ( struct KeyMap * ) Create and set.
  251.                           This tag may be used to  set  the  KeyMap to use  for
  252.                           the  hotkey  handling.   Defaults  to  NULL  (default
  253.                           KeyMap)
  254.     HKH_UseNewButton    - ( BOOL ) Create only.
  255.                           The hotkey  routines  support a  new  button  gadget.
  256.                           This new button gadget is compatible with the  normal
  257.                           gadtools button except that the hotkey is  handled as
  258.                           described in  the  User Interface Style Guide.   This
  259.                           means that the gadget  appears down-pressed  when the
  260.                           hotkey is pressed. When TRUE is specified  with  this
  261.                           tag the normal button gadgets will  automatically  be
  262.                           replaced by the new button gadget.
  263.     HKH_NewText         - (BOOL) Create only.
  264.                           This will use the library it's text-class to  produce
  265.                           the gadget  texts  of  the  gadgets  created   by the
  266.                           GTX_CreateGadgetA() call. The advantage, I think,  is
  267.                           that it produces better underscored  characters  with
  268.                           fonts like topaz.
  269.     HKH_SetRepeat       - (UWORD) Create and set.
  270.                           This  tag  will  enable  you  to  selectively  enable
  271.                           keys that  are in repeat mode to affect  the  gadget.
  272.                           Normally the  hotkeys that  are in  repeat  mode will
  273.                           *not* affect the  gadget.    With  this tag  you  can
  274.                           specify which  gadgets  should  respond  to  repeated
  275.                           hotkeys. The following flags are allowed:
  276.  
  277.                           SRF_MX        - MX kind.
  278.                           SRF_CYCLE     - CYCLE kind.
  279.                           SRF_SLIDER    - SLIDER kind.
  280.                           SRF_SCROLLER  - SCROLLER kind.
  281.                           SRF_LISTVIEW  - LISTVIEW kind.
  282.                           SRF_PALETTE   - PALETTE kind.
  283.  
  284.                           When you specify  SRF_SLIDER  in  this  tag then  all
  285.                           SLIDER gadgets  that  have  a  hotkey  defined   will
  286.                           respond to repeated keys.
  287.  
  288.   RESULT
  289.     handle      - This will be non-zero when the handle  was  successfully  set
  290.                   up or NULL uppon failure.  NOTE:  This handle   can  only  be
  291.                   used for *one* window.
  292.  
  293.   BUGS
  294.     None known.
  295.  
  296.   SEE ALSO
  297.     gadtoolsbox/hotkey.h, libraries/gadtools.h, devices/keymap.h,
  298.     GTX_FreeHandle()
  299.  
  300. gadtoolsbox.library/GTX_FreeHandle          gadtoolsbox.library/GTX_FreeHandle
  301.  
  302.   NAME  GTX_FreeHandle()
  303.  
  304.     GTX_FreeHandle( handle );
  305.  
  306.     VOID GTX_FreeHandle( HOTKEYHANDLE );
  307.                          A0
  308.  
  309.   FUNCTION
  310.     To free all system  resources  taken  by the  hotkey  routines.  NOTE:  You
  311.     should have freed the gadgets and closed the  window *before*  freeing  the
  312.     handle.
  313.  
  314.   INPUTS
  315.     handle      - The handle that needs to be free'ed.
  316.  
  317.   RESULT
  318.  
  319.   BUGS
  320.     None known.
  321.  
  322.   SEE ALSO
  323.     GTX_GetHandle()
  324.  
  325. gadtoolsbox.library/GTX_RefreshWindow    gadtoolsbox.library/GTX_RefreshWindow
  326.  
  327.   NAME  GTX_RefreshWindow()
  328.  
  329.     GTX_RefreshWindow( handle, window, requester );
  330.  
  331.     VOID GTX_RefreshWindow
  332.                          ( HOTKEYHANDLE, struct Window *, struct Requester * );
  333.                            A0            A1               A2
  334.  
  335.   FUNCTION
  336.     To setup some important  fields  in the  private HOTKEYHANDLE and then call
  337.     gadtoolsbox.library it's  GT_RefrehWindow() to  refresh the  gadgets.  This
  338.     call *MUST* be made right after the window was opened!
  339.  
  340.   INPUTS
  341.     handle      - The handle as returned by GTX_GetHandle().
  342.     window      - A pointer to the window to refresh.
  343.     requester   - A pointer to a requester.   NOTE:  gadtools does not  support
  344.                   requesters yet so you *MUST* supply null here for now.
  345.  
  346.   RESULT
  347.  
  348.   BUGS
  349.     None known.
  350.  
  351.   SEE ALSO
  352.     gadtools.library/GT_RefreshWindow(), GTX_GetHandle()
  353.  
  354. gadtoolsbox.library/GTX_CreateGadgetA    gadtoolsbox.library/GTX_CreateGadgetA
  355.  
  356.   NAME  GTX_CreateGadgetA()
  357.  
  358.     gadget = GTX_CreateGadgetA( handle, kind, pred, newgad, tags );
  359.  
  360.     struct Gadget *GTX_CreateGadgetA
  361.                ( HOTKEYHANDLE, UWORD, struct Gadget *,
  362.                  A0            D0     A1
  363.                                         struct NewGadget *, struct TagItem * );
  364.                                         A2                  A3
  365.  
  366.     struct Gadget * GTX_CreateGadget
  367.                ( HOTKEYHANDLE, UWORD, struct Gadget *,
  368.                                               struct NewGadget *, Tag, ... );
  369.  
  370.   FUNCTION
  371.     The same as gadtools.library it's CreateGadgetA() except that it  also sets
  372.     up special information for the hotkey  handling of the  gadget.  Also, when
  373.     you passed the HKH_UseNewButton tag to GTX_GetHandleA(),  this routine will
  374.     create a special  BUTTON  gadget  when a  BUTTON_KIND  is  requested.  This
  375.     special BUTTON is compatible with the original except that the  hotkey will
  376.     work as described in the User Interface style Guide.    The  hotkey  system
  377.     currently only allows the  following  characters to  be defined as hotkeys:
  378.  
  379.         a-z/A-Z Uppercase alpha characters are  considered to  be the  same  as
  380.                 their lowercase equivalents.
  381.         0-9
  382.  
  383.   INPUTS
  384.     handle      - The handle as returned by GTX_GetHandle().
  385.     kind        - See gadtools.library/CreateGadgetA().
  386.     pred        - See gadtools.library/CreateGadgetA().
  387.     newgad      - See gadtools.library/CreateGadgetA().
  388.     tags        - See gadtools.library/CreateGadgetA().
  389.  
  390.   RESULT
  391.     gadget      - A pointer to the created gadget or NULL uppon failure.
  392.  
  393.   BUGS
  394.     None known.
  395.  
  396.   SEE ALSO
  397.     gadtools.library/CreateGadgetA(), libraries/gadtools.h, GTX_GetHandle()
  398.  
  399. gadtoolsbox.library/GTX_RawToVanilla()  gadtoolsbox.library/GTX_RawToVanilla()
  400.  
  401.   NAME  GTX_RawToVanilla()
  402.  
  403.     character = GTX_RawToVanilla( handle, code, qualifier );
  404.  
  405.     UBYTE GTX_RawToVanilla( HOTKEYHANDLE, UWORD, UWORD );
  406.     D0                      A0            D0     D0
  407.  
  408.   FUNCTION
  409.     The usage of the hotkey stuff from this library will not  allow you  to use
  410.     both the IDCMP_VANILLAKEY and IDCMP_RAWKEY at the same time. To get the raw
  411.     messages converted into a vanilla key code  you must  use this  routine. It
  412.     will *only* convert keys that map to a *single* character.
  413.  
  414.   INPUTS
  415.     handle      - The handle as returned by GTX_GetHandle().
  416.     code        - The code of the received RAWKEY message.
  417.     qualifier   - The qualifier of the received RAWKEY message.
  418.  
  419.   RESULT
  420.     character   - The converted key or 0 when the  character did not  map  to a
  421.                   single character.
  422.  
  423.   BUGS
  424.     Still needs some work.
  425.  
  426.   SEE ALSO
  427.     console.device/RawKeyConvert()
  428.  
  429. gadtoolsbox.library/GTX_GetIMsg()            gadtoolsbox.library/GTX_GetIMsg()
  430.  
  431.   NAME  GTX_GetIMsg()
  432.  
  433.     message = GTX_GetIMsg( handle, port );
  434.  
  435.     struct IntuiMessage *GTX_GetIMsg( HOTKEYHANDLE, struct MsgPort * );
  436.     D0                                A0            A1
  437.  
  438.   FUNCTION
  439.     This is really the heart of the hotkey system.  This  routine  will convert
  440.     the RAWKEY  messages  that  are assigned  to a  gadget into  a  GADGETUP or
  441.     GADGETDOWN message.  This is simply  done by  changing some  fields  in the
  442.     IntuiMessage structure. This is how hotkeys for  the specific  gadget kinds
  443.     are translated:
  444.  
  445.         Kind:                Class:              Code:                IAddress:
  446.         -----------------------------------------------------------------------
  447.         BUTTON_KIND          IDCMP_GADGETUP      -----                Gadget
  448.         CHECKBOX_KIND        IDCMP_GADGETUP      TRUE or FALSE        Gadget
  449.         INTEGER_KIND         IDCMP_GADGETUP      -----                Gadget
  450.         LISTVIEW_KIND        IDCMP_GADGETUP      Selected node number Gadget
  451.         MX_KIND              IDCMP_GADGETDOWN    Selected label       Gadget
  452.         CYCLE_KIND           IDCMP_GADGETUP      Selected label       Gadget
  453.         PALETTE_KIND         IDCMP_GADGETUP      Selected color       Gadget
  454.         SCROLLER_KIND        IDCMP_GADGETUP      Scroller top         Gadget
  455.         SLIDER_KIND          IDCMP_GADGETUP      Slider level         Gadget
  456.         STRING_KIND          IDCMP_GADGETUP      -----                Gadget
  457.  
  458.     As you can see the CHECKBOX_KIND also sets up the Code field,  TRUE if  the
  459.     gadget is checked and FALSE if not, which eliminates  having to  check  the
  460.     GFLG_SELECTED bit for this kind of gadget.   The  gadget  visuals  are also
  461.     updated utomatically.  For the program that uses the hotkey system a gadget
  462.     activated by the mouse or by the hotkey will be exactly the same.
  463.  
  464.   INPUTS
  465.     handle      - The handle as returned by GTX_GetHandle().
  466.     port        - A pointer to the Window it's message port.
  467.  
  468.   RESULT
  469.     message     - A pointer to  an  IntuiMessage  structure if  a  message  was
  470.                   present at the port or NULL if not.
  471.  
  472.   BUGS
  473.     None known.
  474.  
  475.   SEE ALSO
  476.     gadtools.library/GT_GetIMsg(), libraries/gadtools.h, intuition/intuition.h
  477.     GTX_ReplyIMsg()
  478.  
  479. gadtoolsbox.library/GTX_ReplyIMsg()        gadtoolsbox.library/GTX_ReplyIMsg()
  480.  
  481.   NAME  GTX_ReplyIMsg()
  482.  
  483.     GTX_ReplyIMsg( handle, message );
  484.  
  485.     GTX_ReplyIMsg( HOTKEYHANDLE, struct IntuiMessage * );
  486.                    A0            A1
  487.  
  488.   FUNCTION
  489.     To reply all messages gotten from the port by GTX_GetIMsg() to it's sender.
  490.  
  491.   INPUTS
  492.     handle      - The handle as returned by GTX_GetHandle().
  493.     message     - The message gotten from the message port by GTX_GetIMsg().
  494.  
  495.   RESULT
  496.  
  497.   BUGS
  498.     None known.
  499.  
  500.   SEE ALSO
  501.     gadtools.library/GT_ReplyIMsg(), intuition/intuition.h, GTX_GetIMsg()
  502.  
  503. gadtoolsbox.library/GTX_SetGadgetAttrsA() gadtoolsbox.library/GTX_SetGadgetAttrsA()
  504.  
  505.   NAME  GTX_SetGadgetAttrsA()
  506.  
  507.     GTX_SetGadgetAttrsA( handle, gadget, tags );
  508.  
  509.     GTX_SetGadgetAttrsA( HOTKEYHANDLE, struct Gadget *, struct TagItem * );
  510.                          A0            A1               A2
  511.  
  512.     GTX_SetGadgetAttrs( HOTKEYHANDLE, struct Gadget *, Tag, ... );
  513.  
  514.   FUNCTION
  515.     A replacement call for the original  gadtools.library  GT_SetGadgetAttrsA()
  516.     call.   It updates some internally used data for the gadget and then call's
  517.     the gadtools.library routine.
  518.  
  519.   INPUTS
  520.     handle      - The handle as returned by GTX_GetHandle().
  521.     gadget      - A pointer to the gadget which need changing.
  522.     tags        - A pointer to a tagitem array with the new attributes  for the
  523.                   gadget.
  524.  
  525.   RESULT
  526.  
  527.   BUGS
  528.     None known.
  529.  
  530.   SEE ALSO
  531.     gadtools.library/GT_SetGadgetAttrsA()
  532.  
  533. gadtoolsbox.library/GTX_DetachLabels()  gadtoolsbox.library/GTX_DetachLabels()
  534.  
  535.   NAME  GTX_DetachLabels()
  536.  
  537.     GTX_DetachLabels( handle, gadget );
  538.  
  539.     GTX_DetachLabels( HOTKEYHANDLE, struct Gadget * );
  540.  
  541.   FUNCTION
  542.     To  detach  the list  from an  active  LISTVIEW  gadget.  This  really is a
  543.     shortcut to the GTX_SetGadgetAttrsA() call.
  544.  
  545.   INPUTS
  546.     handle      - The handle as returned by GTX_GetHandle();
  547.     gadget      - A pointer to the LISTVIEW gadget.
  548.  
  549.   RESULT
  550.  
  551.   BUGS
  552.     None known.
  553.  
  554.   SEE ALSO
  555.     GTX_SetGadgetAttrsA()
  556.  
  557. gadtoolsbox.library/GTX_DrawBox()            gadtoolsbox.library/GTX_DrawBox()
  558.  
  559.   NAME  GTX_DrawBox()
  560.  
  561.     GTX_DrawBox( rport, left, top, width, height, drinfo, state );
  562.  
  563.     GTX_DrawBox( struct RastPort *, ULONG, ULONG, ULONG, ULONG,
  564.                  A0                 D0     D1     D2     D3
  565.                                                   struct DrawInfo *, ULONG );
  566.                                                   A2                 D4
  567.  
  568.   FUNCTION
  569.     To render a bevelled box into a RastPort simular to most gadget boxes. This
  570.     routine is used internally by the image classes provided by the library but
  571.     it has been made visible for the people who might need it.
  572.  
  573.   INPUTS
  574.     rport       - A pointer to the RastPort.
  575.     left        - The box it's left edge.
  576.     top         - The box it's top edge.
  577.     width       - The box it's width.
  578.     height      - The box it's height.
  579.     drinfo      - A pointer to the DrawInfo as returned by GetScreenDrawInfo().
  580.     state       - The state in which to render  the  box.   Currently  only two
  581.                   states are supported.
  582.  
  583.                     IDS_NORMAL   - Draw a normal "raised" box with BACKGROUNDPEN
  584.                                    as fill color.
  585.                     IDS_SELECTED - Draw a "recessed" box with  FILLPEN  as fill
  586.                                    color.
  587.  
  588.   RESULT
  589.  
  590.   BUGS
  591.     None known.
  592.  
  593.   SEE ALSO
  594.     intuition.library/GetScreenDrawInfo(), intuition/screens.h,
  595.     intuition/imageclass.h
  596.  
  597. gadtoolsbox.library/GTX_InitTextClass() gadtoolsbox.library/GTX_InitTextClass()
  598.  
  599.   NAME  GTX_InitTextClass()
  600.  
  601.     class = GTX_InitTextClass()
  602.  
  603.     struct IClass *GTX_InitTextClass( void );
  604.     A0
  605.  
  606.   FUNCTION
  607.     Initializes a private BOOPSI text imageclass for usage on custom gadgets.
  608.  
  609.   INPUTS
  610.  
  611.   RESULT
  612.     class       - A  pointer  to the class.   This  pointer must be passed onto
  613.                   NewObject() to obtain objects using this class.
  614.  
  615.   BUGS
  616.     None known.
  617.  
  618.   SEE ALSO
  619.     intuition.library/NewObject(), intuition/classes.h, intuition/classusr.h
  620.     TextClass.doc
  621.  
  622. gadtoolsbox.library/GTX_InitGetFileClass() gadtoolsbox.library/GTX_InitGetFileClass()
  623.  
  624.   NAME  GTX_InitGetFileClass()
  625.  
  626.     class = GTX_InitGetFileClass()
  627.  
  628.     struct IClass *GTX_InitGetFileClass( void );
  629.     A0
  630.  
  631.   FUNCTION
  632.     Initializes a private BOOPSI getfile imageclass for usage on custom gadgets.
  633.  
  634.   INPUTS
  635.  
  636.   RESULT
  637.     class       - A pointer to the class.   This  pointer  must be  passed onto
  638.                   NewObject() to obtain objects using this class.
  639.  
  640.   BUGS
  641.     None known.
  642.  
  643.   SEE ALSO
  644.     intuition.library/NewObject(), intuition/classes.h, intuition/classusr.h
  645.     GetFileClass.doc
  646.  
  647. gadtoolsbox.library/GTX_SetHandleAttrsA() gadtoolsbox.library/GTX_SetHandleAttrsA()
  648.  
  649.   NAME  GTX_SetHandleAttrsA()
  650.  
  651.     GTX_SetHandleAttrsA( handle, tags );
  652.  
  653.     GTX_SetHandleAttrsA( HOTKEYHANDLE, struct TagItem * );
  654.                          A0            A1
  655.  
  656.     GTX_SetHandleAttrs( HOTKEYHANDLE, Tag, ... );
  657.  
  658.   FUNCTION
  659.     To change some of the attributes of the HOTKEYHANDLE.
  660.  
  661.   INPUTS
  662.     handle      - The handle as returned by GTX_GetHandle()
  663.     tags        - A pointer to a tagitem array containing the new attributes.
  664.  
  665.   RESULT
  666.  
  667.   BUGS
  668.     None known.
  669.  
  670.   SEE ALSO
  671.     GTX_GetHandleA()
  672.  
  673. gadtoolsbox.library/GTX_BeginRefresh()  gadtoolsbox.library/GTX_BeginRefresh()
  674.  
  675.   NAME  GTX_BeginRefresh()
  676.  
  677.     GTX_BeginRefresh( handle );
  678.  
  679.     GTX_BeginRefresh( HOTKEYHANDLE );
  680.                       A0
  681.  
  682.   FUNCTION
  683.     A replacement call for the gadtools.library GT_BeginRefresh()  call.
  684.  
  685.   INPUTS
  686.     handle      - The handle as returned by GTX_GetHandle().
  687.  
  688.   RESULT
  689.  
  690.   BUGS
  691.     None known.
  692.  
  693.   SEE ALSO
  694.     GTX_EndRefresh(), gadtools.library/GT_BeginRefresh()
  695.  
  696. gadtoolsbox.library/GTX_EndRefresh()      gadtoolsbox.library/GTX_EndRefresh()
  697.  
  698.   NAME  GTX_EndRefresh()
  699.  
  700.     GTX_EndRefresh( handle, all );
  701.  
  702.     GTX_BeginRefresh( HOTKEYHANDLE, LONG );
  703.                       A0            D0
  704.  
  705.   FUNCTION
  706.     A replacement call for the gadtools.library GT_EndRefresh() call.
  707.  
  708.   INPUTS
  709.     handle      - The handle as returned by GTX_GetHandle().
  710.     all         - See gadtools.library GT_EndRefresh().
  711.  
  712.   RESULT
  713.  
  714.   BUGS
  715.     None known.
  716.  
  717.   SEE ALSO
  718.     GTX_BeginRefresh(), gadtools.library/GT_EndRefresh()
  719.  
  720. gadtoolsbox.library/GTX_FreeWindows()    gadtoolsbox.library/GTX_FreeWindows()
  721.  
  722.   NAME  GTX_FreeWindows()
  723.  
  724.     GTX_FreeWindows( chain, windows );
  725.  
  726.     GTX_FreeWindows( struct MemoryChain *, struct WindowList * );
  727.                      A0                    A1
  728.  
  729.   FUNCTION
  730.     To deallocate all memory taken by the WindowList.
  731.  
  732.   INPUTS
  733.     chain       - A  pointer  to the  MemoryChain  in which  the  WindowList is
  734.                   allocated.
  735.     windows     - A pointer to the WindowList which needs to be deallocated.
  736.  
  737.   RESULT
  738.  
  739.   BUGS
  740.     None known.
  741.  
  742.   SEE ALSO
  743.     GTX_LoadGUIA()
  744.  
  745. gadtoolsbox.library/GTX_LoadGUIA()         gadtoolsbox.library/GTX_LoadGUIA()
  746.  
  747.   NAME  GTX_LoadGUIA()
  748.  
  749.     error = GTX_LoadGUIA( chain, name, tags );
  750.  
  751.     LONG GTX_LoadGUIA( struct MemoryChain *, UBYTE *, struct TagItem * );
  752.     D0                 A0                    A1       A2
  753.  
  754.     LONG GTX_LoadGUI( struct MemoryChain *, UBYTE *, Tag, ... );
  755.  
  756.   FUNCTION
  757.     To read a GadToolsBox GUI file into memory.    NOTE: When you  want to load
  758.     a powerpacker crunched GUI file you should make sure of two things:
  759.  
  760.         1)  The powerpacker.library V35 or better is available.
  761.         2)  You have setup T: as a logical device.
  762.  
  763.   INPUTS
  764.     chain       - A pointer  to the  MemoryChain in  which the GUI file will be
  765.                   allocated.
  766.     name        - A pointer to the name of the GUI file to load.
  767.     tags        - A pointer to a tagitem array.
  768.  
  769.   TAGS
  770.     RG_GUI              - ( GUIDATA * )
  771.                           A pointer to  enough  memory to hold sizeof( GUIDATA)
  772.                           bytes.    The ID_GXUI  chunk of  the GUI file will be
  773.                           stored here. May be NULL.
  774.  
  775.     RG_Config           - ( struct GadToolsConfig * )
  776.                           A pointer to enough  memory  to hold   sizeof( struct
  777.                           GadToolsConfig ) bytes.    The  ID_GTCO  chunk of the
  778.                           GUI file will be stored here. May be NULL.
  779.  
  780.     RG_CConfig          - ( struct GenC * )
  781.                           A pointer to  enough  memory to hold   sizeof( struct
  782.                           GenC ) bytes.     The  ID_GENC chunk  of the GUI file
  783.                           will be stored here. May be NULL.
  784.  
  785.     RG_AsmConfig        - ( struct GenAsm * )
  786.                           A pointer to  enough  memory to hold   sizeof( struct
  787.                           GenAsm ) bytes.   The  ID_GENA chunk  of the GUI file
  788.                           will be stored here. May be NULL.
  789.  
  790.     RG_LibGen           - NOT SUPPORTED YET.
  791.  
  792.     RG_WindowList       - ( struct WindowList * )
  793.                           A pointer to a  WindowList  structure  in  which  all
  794.                           loaded  windows  will  be  appended.   May  be  NULL.
  795.                           NOTE: The  list is  initialized by the library so you
  796.                                 must  have  de-allocated  any  windows  from  a
  797.                                 previous GTX_LoadGUI() call.
  798.  
  799.     RG_Valid            - ( ULONG * )
  800.                           A pointer to  an ULONG in  which  validation  bits of
  801.                           the loaded file will  be set.  The following bits can
  802.                           be set in here.
  803.  
  804.                             VLF_GUI        - An ID_GGUI chunk has been loaded.
  805.                             VLF_CONFIG     - An ID_GTCO chunk has been loaded.
  806.                             VLF_CCONFIG    - An ID_GENC chunk has been loaded.
  807.                             VLF_ASMCONFIG  - An ID_GENA chunk has been loaded.
  808.                             VLF_LIBGEN     - NOT SUPPORTED YET.
  809.                             VLF_WINDOWLIST - There where windows loaded.
  810.  
  811.                           When you load a  file and  the  VLF_CONFIG bit is not
  812.                           set it means that  there was no ID_GTCO chunk loaded.
  813.                           NOTE: Even  when the  loading  returned  an error you
  814.                                 still  *must*  call  GTX_FreeWindows()  to  de-
  815.                                 allocate the   windows  when the VLF_WINDOWLIST
  816.                                 flag is set!
  817.  
  818.     RG_PasswordEntry    - ( APTR )
  819.                           This may  point to a routine  which  will be  used by
  820.                           the library  to get the password  from a  user when a
  821.                           crypted  powerpacker file  is  loaded.   The  routine
  822.                           should  expect the following parameters on the stack:
  823.  
  824.                             UBYTE *password, ULONG checksum
  825.  
  826.                           Please  read the  powerpacker.library  docs  for some
  827.                           information on how to handle the password checking.
  828.  
  829.   RESULT
  830.     error       - NULL  to  indicate  that everything  is fine  and any  of the
  831.                   following to indicate an error:
  832.  
  833.                     ERROR_NOMEM         - Not enough memory.
  834.                     ERROR_OPEN          - Could not open the file.
  835.                     ERROR_READ          - Read Error.
  836.                     ERROR_WRITE         - Write Error.
  837.                     ERROR_PARSE         - iffparse.library error.
  838.                     ERROR_PACKER        - powerpacker.library error.
  839.                     ERROR_PPLIB         - The  file  was   crunched   and   the
  840.                                           powerpacker  library  V35+  failed to
  841.                                           open.
  842.                     ERROR_NOTGUIFILE    - The file is not a GadToolBox GUI file
  843.  
  844.   SEE ALSO
  845.     powerpacker.library/ppLoadData(), gadtoolsbox/gui.h, gadtoolsbox/forms.h
  846.     gadtoolsbox/prefs.h
  847.